@types/js-yaml

What is @types/js-yaml?

The @types/js-yaml package provides TypeScript type definitions for the js-yaml package, which is a YAML parser and serializer. This allows developers using TypeScript to work with js-yaml more effectively by providing compile-time type checking and IntelliSense support in code editors. The main functionalities include parsing YAML strings into JavaScript objects and serializing JavaScript objects into YAML strings.

What are @types/js-yaml's main functionalities?

Parsing YAML to JavaScript Object

This feature allows you to parse a YAML string into a JavaScript object. It's useful for reading configuration files or data serialization formats that are easier to read and write for humans than JSON.

import * as yaml from 'js-yaml';
let doc = yaml.load('foo: bar');
console.log(doc); // Outputs: { foo: 'bar' }

Serializing JavaScript Object to YAML

This feature enables you to serialize a JavaScript object into a YAML string. It's beneficial for generating configuration files or data serialization formats that need to be human-readable.

import * as yaml from 'js-yaml';
let obj = { foo: 'bar' };
let yml = yaml.dump(obj);
console.log(yml); // Outputs YAML string representation of the object

Other packages similar to @types/js-yaml

yaml

The 'yaml' package is a modern YAML parser and stringifier, supporting YAML 1.2. It offers similar functionality to js-yaml but with a more modern codebase and API. It might be preferred for new projects for its updated features.

yamljs

Yamljs is another YAML parser and serializer for JavaScript. Compared to js-yaml, it might be less popular and not as actively maintained. However, it provides basic parsing and serialization capabilities.

README

Installation

npm install --save @types/js-yaml

Summary

This package contains type definitions for js-yaml (https://github.com/nodeca/js-yaml).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/js-yaml/v3.

Additional Details

• Last updated: Tue, 07 Nov 2023 20:08:00 GMT
• Dependencies: none

Credits

These definitions were written by Bart van der Schoor, Sebastian Clausen, and ExE Boss.